home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / tsblue20.zip / TSBLUES.DOC < prev    next >
Text File  |  1992-04-05  |  17KB  |  396 lines

  1.  
  2.  
  3.  
  4.         The Token Street Blues Stock Market Simulation
  5.                 Version 2.0 Production Release
  6.                   A Multiplayer Door Program
  7.  
  8.                   (c) Copyright 1989-1992 By
  9.                       Glen R. Fredericks
  10.                      All Rights  Reserved
  11.  
  12.                 Latest Versions Available From
  13.                       The Token Ring BBS
  14.               201-546-1468   1200-38400bps (HST)
  15.               201-478-6448   1200-19200bps (HST)
  16.  
  17.  
  18.                          Description
  19.                          -----------
  20.      The Token Street Blues is a multi-player stock market
  21. simulation door designed to closely mimic and operate like a
  22. real stock market.  Players compete based on achieving the
  23. highest annualized rate of return on their initial $10,000 in
  24. play money.  Noteworthy aspects of the door include, but are
  25. not limited to, the following:
  26.      - daily maintenance program which leaves nothing for the
  27.        sysop to do
  28.      - realistic price fluctuations reflective of probability
  29.        factors contributed by company news releases and
  30.        general economic climate
  31.      - discount broker commission rates on purchase and sale
  32.        of securities and options
  33.      - broker messages to inform players of news about their
  34.        holdings or margin calls or margin sales
  35.      - news generator which creates news for companies
  36.        affecting their day to day price performance
  37.      - general economic new generator which creates news
  38.        affecting the overall trend of the market
  39.      - 60 day price history including shares currently
  40.        outstanding for all issues on the exchange
  41.      - 60 day price history for the general market including
  42.        the current market capitalization
  43.      - current price, 60 day high and low, shares outstanding
  44.        listing
  45.      - graphical display of the most recent 15 days price
  46.        performance for each issue
  47.      - complete account maintenance and portfolio analysis
  48.        for all players
  49.      - a financial newspaper which maintains the most recent
  50.        100 news items concerning companies and the general
  51.        market
  52.      - margin accounting for all players, including margin
  53.        calls and automatic sell off after 5 consecutive
  54.        margin calls
  55.      - occasional prime rate changes which affects the trend
  56.        of the market and the interest paid on cash balances
  57.        and margin debt
  58.      - player rankings based on annualized return so that a
  59.        player may start the game at any time
  60.      - online instructions and command summary
  61.      - short selling of securities
  62.      - options trading of calls and puts
  63.      - exchange report on issues listing activity in a stock
  64.  
  65.                         Sysop Features
  66.                         --------------
  67.      The Token Street Blues has the ability to carry on a
  68. CHAT (using the F10 key) with the user while he is inside the
  69. door. The F8 key can be used to force a player out of the
  70. door and back to the main bbs. The F9 key allows the sysop to
  71. toggle the local display screen on and off.  This door has
  72. been designed to be self-maintaining thereby requiring little
  73. if any intervention on the part of the sysop.
  74.  
  75.                      System Requirements
  76.                      -------------------
  77.      The successful operation of this program will require
  78. the following:
  79.  
  80.             IBM-PC or 100% Compatible Computer
  81.             PCBoard 14.x Software or BBS Software compatible
  82.                with PCBoard Door programs.
  83.  
  84.                         Files Required
  85.                         --------------
  86.      The operation of this program requires the presence of
  87. the following files:
  88.  
  89.      Token Street Door Subdirectory
  90.      ------------------------------
  91.      BRUN30.exe   ==> DTR/38400 Patched QB3.0 Run Time Module
  92.      TSBLUES.exe  ==> Executable Program File Ver.  x.x
  93.      TSMAINT.exe  ==> Token Street Daily Maintenance Program
  94.      TSREPORT.exe ==> Token Street Blues Reporter/Editor
  95.      TSSUBS.exe   ==> Token Street Subroutine Library
  96.      TS.cfg       ==> Token Street Configuration File
  97.      TSSTOCKS.dat ==> Token Street Company Datafile
  98.      TSTRADER.dat ==> Token Street Player Datafile
  99.      TSOWNERS.dat ==> Token Street Owners Datafile
  100.      TSOPTION.dat ==> Token Street Option Datafile
  101.      TSNEWS.dat   ==> Token Street News Datafile
  102.      TSSMSG.dat   ==> Token Street Messages To Sysop
  103.      TSPMSG.dat   ==> Token Street Player Messages
  104.      TSHELP.doc   ==> Token Street Player Instructions
  105.      TSOPEN       ==> Opening Message File (Ascii)
  106.      TSOPENG      ==> Opening Message File (Ansi)
  107.      TSCLOSE      ==> Closing Message File (Ascii)
  108.      TSCLOSEG     ==> Closing Message File (Ansi)
  109.  
  110.      PCBoard Files
  111.      -------------
  112.      PCBOARD.sys     ==>  User file created by PCBoard
  113.      EVENT.sys       ==>  Timed Event Batch File
  114.  
  115.      The following files should have been included in the
  116. distribution archive:
  117.  
  118.      TSSETUP.exe  <-- Token Street Initialization Program
  119.      TSBLUES.exe  <-- Executable Program File Version x.x
  120.      TSMAINT.exe  <-- Token Street Daily Maintenance Program
  121.      TSREPORT.exe <-- Token Street Blues Reporter/Editor
  122.      TSSUBS.exe   <-- Token Street Blues Subroutine Library
  123.      BRUN30.exe   <-- DTR/38400 Patched QB3.0 Run Time Module
  124.      TS1.cfg      <-- Sample Configuration File Node 1
  125.      TS2.cfg      <-- Sample Configuration File Node 2
  126.      TSBLUES.doc  <-- Sysop Documentation
  127.      TSHELP.doc   <-- Token Street Player Instructions
  128.      TSBLUES      <-- Sample DOOR batch file
  129.      TSSETUP.ini  <-- Token Street Initialization Datafile
  130.      TSOPENG      <-- Ansi Welcome Screen
  131.      TSOPEN       <-- Ascii Welcome Screen
  132.      TSCLOSEG     <-- Ansi Closing Screen
  133.      TSCLOSE      <-- Ascii Closing Screen
  134.      README.doc   <-- Read this before doing anything
  135.  
  136.     OPTIONS.exe has been provided for those currently running
  137. The Token Street Blues Door so that reinitialization is not
  138. needed. Options.exe will create the datafile necessary for
  139. options trading. You must either run options.exe OR
  140. reinitialize to use this version of The Token Street Blues
  141. Door.
  142.  
  143.                         Initialization
  144.                         --------------
  145.      The Token Street Blues data files must be created and
  146. initialized prior to operation of the door. The program
  147. TSSETUP.exe and a sample data file TSSETUP.ini have been
  148. provided for this purpose.  While in the Token Street
  149. subdirectory location and in the presence of the TSSETUP.ini
  150. datafile (see note below regarding customization of the Token
  151. Street exchange companies) execute the program TSSETUP.exe.
  152. Supply the password for entry into the editor and let the
  153. program run (a few minutes).  After completing the setup,
  154. both the TSSETUP.ini and TSSETUP.exe files may be removed.
  155. You should run TSMAINT immediately after initializing.
  156.  
  157.                         Customization
  158.                         -------------
  159.      The file TSSETUP.ini contains the company ticker symbol
  160. and name and the initial prices for all the issues on the
  161. exchange. You may have up to 250 companies listed, however,
  162. you may want to start out with only 15-25 and add companies
  163. as the market volume grows. Use the format in the supplied
  164. TSSETUP.ini if you choose to customize at this time.
  165.  
  166.                       Program Operation
  167.                       -----------------
  168.      The file TS.cfg must contain the following information
  169. as a minimum for proper program operation:
  170.  
  171.      Registration#      --> Place your Token Street Blues
  172.                             registration number here
  173.      d:\Pcboard.sys     --> The complete drive\sub-directory
  174.                             path to the system file
  175.                             PCBOARD.sys
  176.      BBS Name           --> The Name of your BBS System
  177.      d:\PCB\GEN\blt     --> A complete drive\sub-directory\
  178.                             filename for the top 10 bulletin
  179.                             Do not use an extension!
  180.                             Maximum length is 7 characters!
  181.      mm                 --> The number of minutes a user will
  182.                             be allowed in the door.  A value
  183.                             of 0 defaults the time to that
  184.                             remaining on the board.
  185.  
  186.      A sample configuration file is included to provide help
  187. in implementing Token Street. The configuration file may be
  188. created with any good text editor such as edlin or many word
  189. processing programs.
  190.  
  191.           TS.cfg
  192.           ----------
  193.           XX1234
  194.           C:\PCB\PCBoard.sys
  195.           The Token Ring BBS
  196.           C:\PCB\GEN\BLT19
  197.           30
  198.  
  199.      The configuration file must be located in the default
  200. directory along with the required files mentioned above.
  201. Since the name of the configuration file is not hard coded
  202. Into the program, you may name the configuration file
  203. anything you desire.  However, since this flexibility is
  204. built into the software, the name of the configuration file
  205. must be passed to the program at the time of invocation from
  206. the door batch file used to run the program.
  207.  
  208.                     Invocation Batch File
  209.                     ---------------------
  210.      Each door program which runs under PCBoard must have a
  211. batch file associated with it which carries out the necessary
  212. housekeeping tasks for PCBoard.  This file changes directory
  213. areas if necessary, invokes the program and passes necessary
  214. parameters, and returns the user to PCBoard when the door
  215. function is completed.  An example invocation batch file is
  216. included.
  217.  
  218.           TSBLUES  ---->  Sample Door Batch File
  219.           -------
  220.           echo off
  221.           cd c:\pcb\tsblues
  222.           tsblues ts.cfg    (use tsx.cfg for multinode
  223.           cd c:\pcb operation)
  224.           board
  225.  
  226.  
  227.                       Daily Maintenance
  228.                       -----------------
  229.      TSMAINT.exe is the daily maintenance program which
  230. performs the important tasks of computing stock price
  231. movements, generating company specific news releases and
  232. recording associated probability factors, sending broker
  233. messages and margin calls to players, packing the broker
  234. message base, deleting inactive players and generating
  235. general economic news. For proper operation of Token Street,
  236. this program must be located in the Token Street subdirectory
  237. and run at least once per day.  It is conveniently run from
  238. within the PCBoard event.sys on a daily basis, e.g.
  239.  
  240.            EVENT.sys  <---  Insert within Event.sys
  241.            ---------
  242.            ..
  243.            cd c:\pcb\tsblues
  244.            tsmaint c:\pcb\gen\blt19
  245.            cd c:\pcb
  246.            ..
  247.  
  248.      The path and filename for the top ten player bulletin is
  249. optional and may be included in the TSMAINT command line as
  250. shown above.
  251.  
  252.  
  253.                  Token Street Editor/Reporter
  254.                  ----------------------------
  255.      The editor allows the sysop to add new companies to the
  256. exchange, view player records and holdings, view company
  257. records and individual holders and view the messages to the
  258. sysop. The editor may be entered by the SYSOP from Token
  259. Street or you may alternatively set it up as a separate door
  260. in the same way that Token Street is configured.
  261.  
  262.  
  263.                   Ctty/Watchdog/Carrier Loss
  264.                   --------------------------
  265.      Ctty and Watchdog are not required for use of this
  266. program.  The program contains its own built in communication
  267. routines and monitors the com port to insure carrier is
  268. present.  If carrier should drop for any reason the user is
  269. returned to pcboard where appropriate action is taken by the
  270. BBS software to log the user off the system.
  271.      NOTE: The use of watchdog or similar programs which
  272.      reboot the system may result in the incomplete update of
  273.      a players record on loss of carrier.
  274.  
  275.  
  276.                      Multinode Operation
  277.                      -------------------
  278.      PLEASE NOTE: Multinode operation is not currently fully
  279.      operational.  The program is capable of multinode
  280.      operation.  If it is used in a multinode configuration
  281.      then a separate configuration file must be maintained
  282.      for each node of the system.  If you are running in a
  283.      network environment also it will be necessary to pass an
  284.      additional parameter to the program in the door batch
  285.      file which is used to invoke the program  the command
  286.      line should also contain the /NETWORK parameter.
  287.  
  288.                    TSBLUES TSx.cfg /NETWORK
  289.  
  290.      Where the "x" is the node number the program is running
  291.      on. The reason for passing this parameter is so that the
  292.      network file/record locking mechanisms in the program
  293.      may be activated in order to properly function in a
  294.      network environment.
  295.  
  296.  
  297.                    User Supported Software
  298.                    -----------------------
  299.      This version and all previous versions of The Token
  300. Street Blues Stock Market Simulation Door are NOT public
  301. domain and are (c)copyrighted by Glen R. Fredericks with all
  302. rights reserved. It may NOT be distributed for personal gain
  303. under any circumstances.
  304.      The TSBLUExx.zip file in its original form may be copied
  305. and distributed thru bulletin board systems provided no fee
  306. is charged for its distribution and provided no modifications
  307. are made to the program and/or supplementary files contained
  308. therein.
  309.      User Supported Software is a way for you to review a
  310. program on a trial basis and test its operation on your
  311. system prior to purchasing it. Under this type of
  312. distribution system, you are insured that the program meets
  313. your needs and requirements prior to purchase and
  314. registration.
  315.     If after a trial period of up to 15 days you find that
  316. The Token Street Blues fulfills the needs and requirements of
  317. your system, you are REQUIRED to register your copy.  If you
  318. do not wish to register then you should cease use of the
  319. software product.  Please note that registration is mandatory
  320. and is a condition for continued use for this software.
  321.  
  322.  
  323.  
  324.            Token Street Blues Program Registration
  325.            ---------------------------------------
  326.  
  327.            Send To:  Glen R. Fredericks
  328.                      109 E. 1st St.
  329.                      Clifton, NJ  07011
  330.  
  331.  
  332.  
  333. Name:_____________________________________________________
  334.  
  335. Address:__________________________________________________
  336.  
  337. City:__________________________ State:______ Zip:_________
  338.  
  339. Phone:____________________ Date:__________________________
  340.  
  341. BBS Name:_________________________________________________
  342.  
  343. Sysop's Name:_____________________________________________
  344.  
  345. BBS Phone:______________________ Copies:_____ @30.00 each.
  346.  
  347.      Please enclose a registration fee of $30.00 for each
  348. copy to be registered.  Upon receipt of your registration
  349. form and fee, you will be sent the latest version of The
  350. Token Street Blues Door and a unique registration number for
  351. each copy ordered identifying your BBS.  This registration
  352. number and exact BBS name must be placed in each of your
  353. configuration files to activate registration.  Registered
  354. users/owners of The Token Street Blues Stock Market
  355. Simulation Door will be notified users of future software
  356. releases and/or enhancements and to provide software support.
  357. Registered owners will be authorized on-line access to the
  358. Token Ring BBS Sysop's Conference with subscription access
  359. privileges.
  360.  
  361.  
  362.                  Miscellaneous - Please Read
  363.                  ---------------------------
  364.      If you have any problems, bug reports or questions
  365. concerning the use of this program, please contact me at The
  366. Token Ring BBS at 201-546-1468 (24 hours a day/7 days a
  367. week). I would greatly appreciate hearing from you with
  368. suggestions for improvements or other comments.  This will
  369. greatly assist me in the continued support and development of
  370. the Token Street Blues door. I thank you for your cooperation
  371. and hope that you and your callers enjoy the excitment of
  372. simulated stock market trading.  The latest version of this
  373. software can always be obtained from within the The Token
  374. Ring BBS Sysop's Conference.
  375.  
  376.           Glen R. Fredericks            The Token Ring BBS
  377.           109 E. 1st St.                201-546-1468
  378.           Clifton, NJ  07011            24 Hours PCPable
  379.  
  380. In extreme circumstances, you may contact me by voice at one
  381.  of the following numbers:    201-365-8568 (weekdays)
  382.                               201-340-1186 (all other)
  383.  
  384.  
  385.                           Disclaimer
  386.                           ----------
  387.      This software is provided on an "As Is" basis without
  388. warranty either implied or expressed of any kind.  Glen R.
  389. Fredericks, the author and sole owner of this software, takes
  390. no responsibility for loss of data or damage to equipment
  391. thru the use of this software.  Should the software prove
  392. defective the entire burden of any and all repairs and
  393. replacements and/or data restoration rests with the user.  In
  394. no event will the author be liable for any costs and/or
  395. losses either tangible or intangible arising from the use of
  396. this software.